docs: add module docstrings and improve method docstrings in galaxy package#293
Merged
docs: add module docstrings and improve method docstrings in galaxy package#293
Conversation
…ackage - Add module-level docstrings to galaxy.py, galaxies.py, redshift.py, and to_inversion.py explaining what each module contains and its role in the modeling pipeline - Add docstring to Galaxy.traced_grid_2d_from explaining the lensing ray-tracing equation β = θ − α(θ) - Move Galaxy.half_light_radius property to sit with the traced grid method and add a docstring explaining why it returns None - Add docstring to Galaxies.redshift property - Add module docstring to to_inversion explaining how linear profiles and pixelizations are converted to inversion objects Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
galaxy.py,galaxies.py,redshift.py, andto_inversion.pyGalaxy.traced_grid_2d_fromexplaining the lensing ray-tracing equation β = θ − α(θ)half_light_radiusproperty with docstring explaining why it returnsNonefor a multi-component galaxyGalaxies.redshiftpropertyto_inversionexplaining the linear profile / pixelization → inversion pipelineTest plan
🤖 Generated with Claude Code